INinfobip
platform
numbers
number-registration
campaigns

Create Campaign

Creates a campaign within the Infobip platform. This operation does not register the campaign with any networks. Registration can be done using created campaign's ID with the 'Register Campaign' endpoint.

post/number-registration/1/campaigns

Request

  • Base URL
    https://api.infobip.com (the document declares no server; this is the origin it was published from)
  • Auth
    • OAuth 2
      Client credentials
      Token URL: https://api.infobip.com/auth/1/oauth2/token
    • or API key in header Authorization
    • or API key in header Authorization
    • or HTTP basic

Headers

X-Resource-Request-Idstring

Request body

idstring uuid

The identifier for the campaign.

referenceIdstring

Unique user defined ID for the campaign. While not required, it is recommended to supply a referenceId as the uniqueness constraint will help ensure a campaign is not accidentally created multiple times. Subsequent create requests with the same referenceId will be rejected with an error.

applicationIdstring

CPaaS X property identifying an application, a use case or an environment on your system. It should only be set if you are using CPaaS X Applications with your traffic.

entityIdstring

CPaaS X property identifying an unique actor on your system. Should only be set if you are using CPaaS X Applications with your traffic.

namestring required

The name of the campaign.

createdDatestring date-time

The date and time when the campaign was created.

lastModifiedDatestring date-time

The date and time when the campaign was last modified.

stage'DRAFT' | 'SUBMITTED_FOR_REVIEW' | 'IN_REVIEW' | 'UPDATE_REQUESTED_BY_INTERNAL_REVIEWER' | 'APPROVED_BY_INTERNAL_REVIEWER' | 'SUBMITTED' | 'REJECTED_EXTERNALLY' | 'REGISTERED' | 'REJECTED' | 'ON_HOLD' | 'DEREGISTERED' | 'REGISTERED_PENDING_UPDATE' | 'REGISTERED_PENDING_DEREGISTRATION' | 'ARCHIVED' | 'BLOCKED' | 'SUSPENDED' | 'APPEALED' | 'IN_MIGRATION' | 'PAUSED'
type'TEN_DIGIT_LONG_CODE' | 'EXTERNAL_TEN_DIGIT_LONG_CODE' | 'SHORT_CODE' | 'DCA2_TEN_DIGIT_LONG_CODE' | 'TOLL_FREE_NUMBER' | 'TOLL_FREE_UNIFIED_NUMBER' | 'TOLL_FREE_EXTERNALLY_VERIFIED' | 'RCS_SENDER_LAUNCH'

Campaign type.

Response

Created

idstring uuid

The identifier for the campaign.

referenceIdstring

Unique user defined ID for the campaign. While not required, it is recommended to supply a referenceId as the uniqueness constraint will help ensure a campaign is not accidentally created multiple times. Subsequent create requests with the same referenceId will be rejected with an error.

applicationIdstring

CPaaS X property identifying an application, a use case or an environment on your system. It should only be set if you are using CPaaS X Applications with your traffic.

entityIdstring

CPaaS X property identifying an unique actor on your system. Should only be set if you are using CPaaS X Applications with your traffic.

namestring required

The name of the campaign.

createdDatestring date-time

The date and time when the campaign was created.

lastModifiedDatestring date-time

The date and time when the campaign was last modified.

stage'DRAFT' | 'SUBMITTED_FOR_REVIEW' | 'IN_REVIEW' | 'UPDATE_REQUESTED_BY_INTERNAL_REVIEWER' | 'APPROVED_BY_INTERNAL_REVIEWER' | 'SUBMITTED' | 'REJECTED_EXTERNALLY' | 'REGISTERED' | 'REJECTED' | 'ON_HOLD' | 'DEREGISTERED' | 'REGISTERED_PENDING_UPDATE' | 'REGISTERED_PENDING_DEREGISTRATION' | 'ARCHIVED' | 'BLOCKED' | 'SUSPENDED' | 'APPEALED' | 'IN_MIGRATION' | 'PAUSED'
type'TEN_DIGIT_LONG_CODE' | 'EXTERNAL_TEN_DIGIT_LONG_CODE' | 'SHORT_CODE' | 'DCA2_TEN_DIGIT_LONG_CODE' | 'TOLL_FREE_NUMBER' | 'TOLL_FREE_UNIFIED_NUMBER' | 'TOLL_FREE_EXTERNALLY_VERIFIED' | 'RCS_SENDER_LAUNCH'

Campaign type.

Changes

No recorded changes to this operation across all 1 revision of this API.