/
Upsert an external identi...

Upsert an external identifier

Request

Creates or updates an external identifier with a specified resource, resource ID, and service name.

Security
SecretApiKey or JWT
Path
resourcestringrequired

Type of resource.

Enum:"customers""invoices""invoice-items""transactions""journal-accounts""journal-entries"
resourceIdstring, <= 50 characters^[@~\-\.\w]+$required

ID of the resource.

servicestringrequired

Name of the external service.

Value:"quickbooks-online"
Bodyapplication/jsonrequired
externalIdentifierstringrequired

ID of the referenced entity within an external service.

curl -i -X PUT \
  'https://www.rebilly.com/_mock/catalog/all/{resource}/{resourceId}/external-identifiers/{service}' \
  -H 'Content-Type: application/json' \
  -H 'REB-APIKEY: YOUR_API_KEY_HERE' \
  -d '{
    "externalIdentifier": "string"
  }'

Responses

External identifier updated.

Headers
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
resourcestringread-only

Type of resource.

Enum:"customers""invoices""invoice-items""transactions""journal-accounts""journal-entries"
resourceIdstringread-only

ID of the resource.

servicestringread-only

Name of the external service.

Value:"quickbooks-online"
externalIdentifierstringrequired

ID of the referenced entity within an external service.

createdTimestring, (date-time)(CreatedTime)read-only

Date and time when the resource is created. This value is set automatically when the resource is created.

updatedTimestring, (date-time)(UpdatedTime)read-only

Date and time when the resource is updated. This value is set automatically when the resource is updated.

Response
{
  "resource": "customers",
  "resourceId": "string",
  "service": "quickbooks-online",
  "externalIdentifier": "string",
  "createdTime": "2019-08-24T14:15:22Z",
  "updatedTime": "2019-08-24T14:15:22Z",
  "_links": [
    { … }
  ]
}