Create entity
Create an entity associated with the specified entityId.
An entity attached to a submitted message will get auto created if it doesn't exit yet. It will get the entityId and entityName being the value passed on a message.
Please log in to see full path URL. Learn why.
post
/provisioning/1/entities
Authorizations:
Scopes:
Request rate limit:
1 requests / second (per account)
Request Body schema:
application/jsoncollapse all -
| entityName | string <= 255 characters Descriptive name of the resource. |
| entityId required | string <= 255 characters The unique identifier of the entity. This ID will be a URL path parameter. We recommend using values that do not need URL encoding for easier interaction with other API endpoints. |
Responses
201
Created
400
Bad Request
401
Unauthorized
403
Forbidden
409
Conflict
429
Too Many Requests
500
Internal Server Error
Request samples
- Payload
- cURL
- Java
- C#
- Go
- Python
- PHP
- JavaScript
- NodeJs
- Ruby
Content type
application/json
Copy
Collapse all {- "entityName": "Test name",
- "entityId": "test-entity"
}Response samples
- 400
- 401
- 403
- 409
- 429
- 500
Content type
application/json
Copy
Collapse all {- "requestError": {
- "serviceException": {
- "messageId": "BAD_REQUEST",
- "text": "Bad request"
}
}
}
Need assistance
Encountering issues
What's new? Check out
Unsure about a term? See
Service status'%3E %3Cpath d='M11.9047 8.47667L19.3513 0H17.5873L11.1187 7.35867L5.956 0H0L7.80867 11.1287L0 20.0167H1.764L8.59067 12.244L14.044 20.0167H20M2.40067 1.30267H5.11067L17.586 18.778H14.8753' fill='%23424B5C'/%3E %3C/g%3E %3Cdefs%3E %3CclipPath id='clip0_3438_1744'%3E %3Crect width='20' height='20.0167' fill='white'/%3E %3C/clipPath%3E %3C/defs%3E %3C/svg%3E)
