/
Create a service credenti...

Create a service credential

Request

Creates a service credential.

Security
SecretApiKey or JWT or ApplicationJWT
Path
typestringrequired

Type of service credential.

Enum:"smtp""webhook""mailgun""sendgrid""aws-ses""oauth2""postmark""experian""taxjar""avalara"
Bodyapplication/jsonrequired

Service credential resource.

hoststringrequired

SMTP host name.

portinteger, [ 1 .. 65535 ]

SMTP port value.

Default:25
encryptionstring

Encryption value.

Default:"none"
Enum:"none""tls""ssl"
authobject(SmtpAuthorization)
curl -i -X POST \
  'https://www.rebilly.com/_mock/catalog/all/service-credentials/{type}' \
  -H 'Content-Type: application/json' \
  -H 'REB-APIKEY: YOUR_API_KEY_HERE' \
  -d '{
    "type": "smtp",
    "host": "string",
    "port": 25,
    "encryption": "none",
    "auth": {
      "type": "none"
    }
  }'

Responses

Service credential created.

Headers
Locationstring, (uri)

Location of the related resource.

Example:"https://api.rebilly.com/example"
X-RateLimit-Limitinteger

Total number of rate limit tokens for this request within a rate limit period. For more information, see Rate limits.

Example:3600
X-RateLimit-Remaininginteger

Remaining number of rate limit tokens for this request within the rate limit period. For example, in the sandbox environment, rate limits for non-GET endpoints are set at 3000 requests per 10 minutes.

Example:3600
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)
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": [
    { … }
  ]
}