logo

Upsert an external identifier

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

SecuritySecretApiKey or JWT
Request
path Parameters
resource
required
string

Type of the resource.

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

ID of the resource.

service
required
string

Name of the service.

Value: "quickbooks-online"
Request Body schema: application/json
required
externalIdentifier
required
string

ID of the referenced entity within an external service.

Responses
200

External identifier updated.

Response Schema: application/json
externalIdentifier
required
string

ID of the referenced entity within an external service.

resource
string

Type of the resource.

Enum: "customers" "invoices" "invoice-items" "transactions" "journal-accounts" "journal-entries"
resourceId
string

ID of the resource entity.

service
string

Name of the external service.

Value: "quickbooks-online"
createdTime
string <date-time> (CreatedTime)

Date and time which is set automatically when the resource is created.

updatedTime
string <date-time> (UpdatedTime)

Date and time which updates automatically when the resource is updated.

Array of objects

Related links.

Array
rel
string

Type of link.

Enum: "self" "externalService"
href
string

Link URL.

201

External identifier created.

Response Headers
Location
string <uri>

Location of the related resource.

Example: "https://api.rebilly.com/example"
Response Schema: application/json
externalIdentifier
required
string

ID of the referenced entity within an external service.

resource
string

Type of the resource.

Enum: "customers" "invoices" "invoice-items" "transactions" "journal-accounts" "journal-entries"
resourceId
string

ID of the resource entity.

service
string

Name of the external service.

Value: "quickbooks-online"
createdTime
string <date-time> (CreatedTime)

Date and time which is set automatically when the resource is created.

updatedTime
string <date-time> (UpdatedTime)

Date and time which updates automatically when the resource is updated.

Array of objects

Related links.

Array
rel
string

Type of link.

Enum: "self" "externalService"
href
string

Link URL.

401

Unauthorized access. Invalid credentials used.

403

Access forbidden.

404

Resource not found.

422

Invalid data sent.

put/{resource}/{resourceId}/external-identifiers/{service}
Request samples
application/json
{
  • "externalIdentifier": "string"
}
Response samples
application/json
{
  • "resource": "customers",
  • "resourceId": "string",
  • "service": "quickbooks-online",
  • "externalIdentifier": "string",
  • "createdTime": "2019-08-24T14:15:22Z",
  • "updatedTime": "2019-08-24T14:15:22Z",
  • "_links": [
    ]
}
➔ Next to Delete an external identifier