Audiences

Audience segments for campaigns

List audiences

get
/audience

Get all audiences with pagination. Searchable: name, description.

Authorizations
AuthorizationstringRequired

API key provided by GoMobile team. Request yours at https://docs.google.com/forms/d/1F6_7OIDNq8_lWgKPyP-DudF3dvBTl31X4dqVf5St2zE

Query parameters
pageintegerOptionalDefault: 1
limitinteger · max: 100OptionalDefault: 20
searchstringOptional
sortBystring · enumOptionalPossible values:
sortOrderstring · enumOptionalDefault: descPossible values:
Responses
200

Paginated list of audiences

application/json
get
/audience

Create audience

post
/audience
Authorizations
AuthorizationstringRequired

API key provided by GoMobile team. Request yours at https://docs.google.com/forms/d/1F6_7OIDNq8_lWgKPyP-DudF3dvBTl31X4dqVf5St2zE

Body
namestringRequired
descriptionstringOptional
Responses
post
/audience

Get audience by ID

get
/audience/{id}
Authorizations
AuthorizationstringRequired

API key provided by GoMobile team. Request yours at https://docs.google.com/forms/d/1F6_7OIDNq8_lWgKPyP-DudF3dvBTl31X4dqVf5St2zE

Path parameters
idstring · uuidRequired
Responses
200

Audience details

application/json
get
/audience/{id}

Update audience

put
/audience/{id}
Authorizations
AuthorizationstringRequired

API key provided by GoMobile team. Request yours at https://docs.google.com/forms/d/1F6_7OIDNq8_lWgKPyP-DudF3dvBTl31X4dqVf5St2zE

Path parameters
idstring · uuidRequired
Body
namestringOptional
descriptionstringOptional
Responses
200

Audience updated

application/json
put
/audience/{id}

Delete audience

delete
/audience/{id}
Authorizations
AuthorizationstringRequired

API key provided by GoMobile team. Request yours at https://docs.google.com/forms/d/1F6_7OIDNq8_lWgKPyP-DudF3dvBTl31X4dqVf5St2zE

Path parameters
idstring · uuidRequired
Responses
200

Audience deleted

application/json
delete
/audience/{id}

Add contacts to audience

post
/audience/{id}/add-contacts
Authorizations
AuthorizationstringRequired

API key provided by GoMobile team. Request yours at https://docs.google.com/forms/d/1F6_7OIDNq8_lWgKPyP-DudF3dvBTl31X4dqVf5St2zE

Path parameters
idstring · uuidRequired
Body
contactsstring · uuid[]Required
Responses
200

Contacts added

application/json
Responsestring · uuid[]
post
/audience/{id}/add-contacts

Last updated