Skip to content
/
Add External ID

Add External ID

Request

Adds a custom integration external identifier to a Project Offering. This can be any opaque string used to correlate the Project Offering with a record in an external system. Strings starting with a reserved 'px_' provider prefix (e.g., 'px_harvest:') are reserved for use by Parallax integrations and not allowed.

Security
ApiKey
Path
offering_idstring, (uuid)required
project_idstring, (uuid)required

The ID of the Project, to which this Project Offering belongs.

Body
external_idstring

An opaque string identifier from an external system. Must not start with a reserved 'px_' provider prefix. Forward slashes (/) are not supported.

curl -i -X POST \
  'https://developer.getparallax.com/_mock/api-documentation/swagger/v1/projects/{project_id}/offerings/{offering_id}/external-ids' \
  -H 'Content-Type: application/json-patch+json' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE' \
  -d '{
    "external_id": "string"
  }'

Responses

Created

Response
No content