Skip to main content
POST

Authorizations

x-api-key
string
header
required

API key used to authenticate and authorise every request. Include it in the x-api-key header.

Headers

Accept
enum<string>
required

Defines the response type.

Available options:
application/vnd.Creative Force.v2.3+json,
application/vnd.Creative Force.v2.3+xml

Body

application/json

Allocation payment comment payload.

allocation_payment
string
required

Slug of the allocation payment to comment on.

Pattern: ^[A-Za-z]{8}$
comment
string
required

Body of the comment.

Maximum string length: 255

Response

Comment added to the allocation payment.

Result of adding a comment to an allocation payment.

allocation-payment
string

Slug of the allocation payment the comment was added to.

comment
string

Body of the comment.

slug
string

URL-safe identifier of the comment.