POST api/CopayPrograms/AddSmsProgram

Request Information

URI Parameters

None.

Body Parameters

CreateCopayRequestModel
NameDescriptionTypeAdditional information
channel

string

None.
brand

string

None.
patient

Patient

None.
GroupNumberKey

string

Required
CopayCardId

string

None.
PhoneNumber

string

None.

Request Formats

application/json, text/json

Sample: 
{
  "channel": "sample string 1",
  "brand": "sample string 2",
  "patient": {},
  "GroupNumberKey": "sample string 3",
  "CopayCardId": "sample string 4",
  "PhoneNumber": "sample string 5"
}

application/xml, text/xml

Sample: 
<CreateCopayRequestModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DigitalWalletService.Models">
  <CopayCardId>sample string 4</CopayCardId>
  <GroupNumberKey>sample string 3</GroupNumberKey>
  <PhoneNumber>sample string 5</PhoneNumber>
  <brand>sample string 2</brand>
  <channel>sample string 1</channel>
  <patient />
</CreateCopayRequestModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

SmsProgramResponseModel
NameDescriptionTypeAdditional information
CopayCardId

string

None.
WalletLink

string

None.
PhoneNumber

string

None.
Errors

Collection of Error

None.

Response Formats

application/json, text/json

Sample: 
{
  "CopayCardId": "sample string 1",
  "WalletLink": "sample string 2",
  "PhoneNumber": "sample string 3",
  "Errors": [
    {
      "Error": "sample string 1"
    },
    {
      "Error": "sample string 1"
    }
  ]
}

application/xml, text/xml

Sample: 
<SmsProgramResponseModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DigitalWalletService.Models">
  <CopayCardId>sample string 1</CopayCardId>
  <Errors>
    <Error>
      <error>sample string 1</error>
    </Error>
    <Error>
      <error>sample string 1</error>
    </Error>
  </Errors>
  <PhoneNumber>sample string 3</PhoneNumber>
  <WalletLink>sample string 2</WalletLink>
</SmsProgramResponseModel>