Update a service credential

Request

Updates a service credential with a specified ID.
Security
SecretApiKey or JWT
Path
typestringrequired
Type of service credential.
Enum:"smtp""webhook""mailgun""sendgrid""aws-ses""oauth2""postmark""experian""taxjar""avalara"
idstring, <= 50 characters^[@~\-\.\w]+$required
ID of the resource.
Bodyapplication/jsonrequired
Service credential resource.
statusstringrequired
Status of the credential.
Enum ValueDescription
active
Credential is active and can be used.
inactive
Credential is temporarily inactivated and cannot be used until reactivated.
deactivated
Credential is permanently deactivated and cannot be reactivated.
typestringrequired

Type of the credential. Value that matches the {type} path parameter. For backward compatibility, when this field is absent, the {type} path parameter supplies the credential type.

Enum:"smtp""webhook""mailgun""sendgrid""aws-ses""oauth2""postmark""experian""avalara"
Discriminator
curl -i -X PATCH \
  'https://www.rebilly.com/_mock/catalog/all/service-credentials/{type}/{id}' \
  -H 'Content-Type: application/json' \
  -H 'REB-APIKEY: YOUR_API_KEY_HERE' \
  -d '{
    "status": "active",
    "type": "smtp"
  }'

Responses

Service credential updated.
Headers
Rate-Limit-Limitinteger

Maximum number of requests available at one time for this rate limit. For more information, see Rate limits.

Example:500
Rate-Limit-Remaininginteger

Number of requests still available for this rate limit. For more information, see Rate limits.

Example:499
Bodyapplication/json
idstring, <= 36 charactersread-only
ID of the credential.
Example:"crd_0YV9Y706QGCB39FQD380G1ZHZH"
statusstringread-only
Status of the credential.
Enum ValueDescription
active
Credential is active and can be used.
inactive
Credential is temporarily inactivated and cannot be used until reactivated.
deactivated
Credential is permanently deactivated and cannot be reactivated.
deactivationTimestring or null, (date-time)read-only
Date and time when the credential is deactivated.
typestringrequired
Type of credential.
Value:"smtp"
Discriminator
hoststringrequired
SMTP host name.
portinteger, [ 1 .. 65535 ]
SMTP port value.
Default:25
encryptionstring
Encryption value.
Default:"none"
Enum:"none""tls""ssl"
authobject(SmtpAuthorization)
_linksArray of objects(SelfLink)read-only
Related links.
hashstring, <= 36 charactersread-onlydeprecated

ID of the credential. Use the id field instead.

Example:"crd_0YV9Y706QGCB39FQD380G1ZHZH"
Response
{
  "id": "crd_0YV9Y706QGCB39FQD380G1ZHZH",
  "hash": "crd_0YV9Y706QGCB39FQD380G1ZHZH",
  "status": "active",
  "deactivationTime": "2019-08-24T14:15:22Z",
  "type": "smtp",
  "host": "string",
  "port": 25,
  "encryption": "none",
  "auth": {
    "type": "none"
  },
  "_links": [
    { … }
  ]
}